Vcenter Namespaces Instances CreateSpec
The Vcenter Namespaces Instances CreateSpec schema contains the specification required to set up a namespace on a single vSphere cluster.
This schema was added in vSphere API 7.0.0.0.
{
"cluster": "string",
"namespace": "string",
"description": "string",
"resource_spec": {},
"access_list": [
{
"subject_type": "string",
"subject": "string",
"domain": "string",
"role": "string",
"identity_provider": "string"
}
],
"storage_specs": [
{
"policy": "string",
"limit": 0
}
],
"networks": [
"string"
],
"vm_service_spec": {
"content_libraries": [
"string"
],
"vm_classes": [
"string"
]
},
"content_libraries": [
{
"content_library": "string",
"writable": false,
"allow_import": false,
"resource_naming_strategy": "string"
}
],
"creator": {
"subject": "string",
"domain": "string"
},
"namespace_network": {
"network_provider": "string",
"network": {
"namespace_network_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"ingress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"egress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"nsx_tier0_gateway": "string",
"subnet_prefix_length": 0,
"routed_mode": false,
"load_balancer_size": "string"
}
}
}Identifier of the cluster on which the namespace is being created.
This property was added in vSphere API 7.0.0.0.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.
Identifier of the namespace. This has DNS_LABEL restrictions as specified in . This must be an alphanumeric (a-z and 0-9) string and with maximum length of 63 characters and with the '-' character allowed anywhere except the first or last character. This name is unique across all Namespaces in this vCenter server. In this version, this maps to the name of a Kubernetes namespace.
This property was added in vSphere API 7.0.0.0.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.
Description for the namespace.
This property was added in vSphere API 7.0.0.0.
If missing or null, no description is added to the namespace.
Resource quota on the namespace. Refer to Vcenter NamespaceManagement NamespaceResourceOptions Info.create_resource_quota_type and use GET /vcenter/namespace-management/clusters/{cluster}/workload-resource-options for retrieving the type for the value for this field. For an example of this, see Vcenter Namespaces ResourceQuotaOptionsV1.
This property was added in vSphere API 7.0.0.0.
If missing or null, no resource limits will be set on the namespace.
Access controls associated with the namespace.
This property was added in vSphere API 7.0.0.0.
If missing or null, only users with Administrator role can access the namespace.
Storage associated with the namespace.
This property was added in vSphere API 7.0.0.0.
If missing or null, storage policies will not be associated with the namespace which will prevent users from being able to provision pods with persistent storage on the namespace. Users will be able to provision pods which use local storage.
The vSphere Namespaces network objects to be associated with the namespace. The values of this list need to reference names of pre-existing Vcenter NamespaceManagement Networks Info schemas.
This property was added in vSphere API 7.0.1.0.
The field must be left missing or null if the cluster hosting the namespace uses NSXT_CONTAINER_PLUGIN or NSX_VPC as the network provider, since the network(s) for this namespace will be managed on NSX.
When using NSXT_CONTAINER_PLUGIN as network provider, a new network dedicated to the namespace will be created as part of namespace creation to override cluster network configs if Vcenter Namespaces Instances NsxNetworkCreateSpec is set.
When using NSX_VPC as network provider, any additional network configuration needs to be specified with Vcenter Namespaces Instances VpcNetworkCreateSpec.
If the field is missing or null when the cluster hosting the namespace uses VSPHERE_NETWORK as its network provider, the namespace will automatically be associated with the cluster's Supervisor Primary Workload Network. The field currently accepts at most only 1 vSphere Namespaces network object reference.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.namespace_management.Network. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.namespace_management.Network.
VM Service specification associated with the namespace.
This property was added in vSphere API 7.0.2.00100.
This property is optional because it was added in a newer version than its parent node.
List of Content Libraries used by the VM Image Service. This list refers to existing Content Libraries in vSphere inventory.
The Content Libraries specified in {VMServiceSpec#contentLibraries} will also be used by the VM Image Service but will be read-only by default to users.
If the same Content Library is present both here and in {VMServiceSpec#contentLibraries}, then:
- The Content Library is only surfaced to users once.
- The settings here are honored.
This property was added in vSphere API 8.0.2.0.
If missing or null, no additional Content Libraries will be configured for the VM Image Service except for the Content Libraries specified in {VMServiceSpec#contentLibraries}.
Creator of the namespace. Namespace self-service uses this field to populate the user who created this namespace.
This property was added in vSphere API 7.0.2.00100.
This property is optional because it was added in a newer version than its parent node.
This field that accepts parameters to define a vSphere Namespace Network object that will automatically be associated with this Namespace. Networks created in this operation will be given an autogenerated ID and cannot be referenced by other Namespaces.
This property was added in vSphere API 7.0.2.00100.
This property is optional because it was added in a newer version than its parent node.